| API Documentation |  |

- MAIN PAGE
- NAMESPACES
- CLASSES

Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 1 2 3 4]

►N nkAstraeus | Encompasses all API of component NilkinsAstraeus
►N lua |
►N stdWrap |
C ArrayWrapper | Wraps available template specializations for std::array and offers functions for use in scripting
►N nkAstraeusWrap | Encompasses the wrapping of nkAstraeus for scripting
C EnvironmentInitializer | Allows to initialize an environment to set up all the offered wrapping for nkAstraeus inside it
C LogWrapper | Wraps the nkAstraeus::LogManager, and offers functions to use it from a scripting environment
►N nkExportWrap | Encompasses the wrapping of nkExport for scripting
C Constants | Constants encompassing user type identifiers for the wrapping of nkExport
C EnvironmentInitializer | Allows to initialize an environment to set up all the offered wrapping for nkExport inside it
C ExporterLoadResultWrapper | Wraps a nkExport::ExporterLoadResult and offer functions for use in scripting
C ExportErrorWrapper | Wraps a nkExport::ExportError and offer functions for use in scripting
C ExportNodeNatureWrapper | Wraps the enum values of the nkExport::NODE_NATURE
C ExportNodeValueTypeWrapper | Wraps the enum values of the nkExport::NODE_VALUE_TYPE
C JsonExporterWrapper | Wraps a nkExport::JsonExporter and offer functions for use in scripting
C NodeWrapper | Wraps a nkExport::Node and offers functions for use in scripting
►N nkGaphicsWrap |
C PrimitiveTopologyWrapper | Wraps the enum values of the nkGraphics::PRIMITIVE_TOPOLOGY
►N nkGraphicsWrap | Encompasses the wrapping of nkGraphics for scripting
C BoundingBoxWrapper | Wraps a nkGraphics::BoundingBox and offers functions for use in scripting
C CameraManagerWrapper | Wraps the nkGraphics::CameraManager and offers functions for use in scripting
C CameraWrapper | Wraps a nkGraphics::Camera and offers functions for use in scripting
C CompositorManagerWrapper | Wraps the nkGraphics::CompositorManager and offers functions for use in scripting
C CompositorNodeWrapper | Wraps a nkGraphics::CompositorNode and offers functions for use in scripting
C CompositorWrapper | Wraps a nkGraphics::Compositor and offers functions for use in scripting
C Constants | Constants encompassing user type identifiers for the wrapping of nkGraphics
C EntityWrapper | Wraps a nkGraphics::Entity and offers functions for use in scripting
C EnvironmentInitializer | Allows to initialize an environment to set up all the offered wrapping for nkGraphics inside it
C FrustumWrapper | Wraps a nkGraphics::Frustum and offers functions for use in scripting
C GltfMeshDecoderWrapper | Wraps a nkGraphics::GltfMeshDecoder and offers functions for use in scripting
C MeshManagerWrapper | Wraps the nkGraphics::MeshManager and offers functions for use in scripting
C MeshWrapper | Wraps a nkGraphics::Mesh and offers functions for use in scripting
C NodeManagerWrapper | Wraps the nkGraphics::NodeManager and offers functions for use in scripting
C NodeWrapper | Wraps a nkGraphics::Node and offers functions for use in scripting
C ProgramManagerWrapper | Wraps the nkGraphics::ProgramManager and offers functions for use in scripting
C ProgramWrapper | Wraps a nkGraphics::Program and offers functions for use in scripting
C RenderQueueManagerWrapper | Wraps the nkGraphics::RenderQueueManager and offers functions for use in scripting
C RenderQueueWrapper | Wraps a nkGraphics::RenderQueue and offers functions for use in scripting
C ResourceLoadStateWrapper | Wraps the enum values of the nkGraphics::RESOURCE_LOAD_STATE
C ShaderManagerWrapper | Wraps the nkGraphics::ShaderManager and offers functions for use in scripting
C ShaderWrapper | Wraps a nkGraphics::Shader and offers functions for use in scripting
C TextureManagerWrapper | Wraps the nkGraphics::TextureManager and offers functions for use in scripting
C TextureSaverWrapper | Wraps the nkGraphics::TextureSaver and offers functions for use in scripting
C TextureUtilsWrapper | Wraps the nkGraphics::TextureUtils and offers functions for use in scripting
C TextureWrapper | Wraps a nkGraphics::Texture and offers functions for use in scripting
C VertexComponentWrapper | Wraps a nkGraphics::VertexComponent and offers functions for use in scripting
C VertexCompositionWrapper | Wraps a nkGraphics::VertexComposition and offers functions for use in scripting
C ViewportManagerWrapper | Wraps the nkGraphics::ViewportManager and offers functions for use in scripting
C ViewportWrapper | Wraps a nkGraphics::Viewport and offers functions for use in scripting
►N nkMathsWrap | Encompasses the wrapping of nkMaths for scripting
C Constants | Constants encompassing user type identifiers for the wrapping of nkMaths
C EnvironmentInitializer | Allows to initialize an environment to set up all the offered wrapping for nkMaths inside it
C MathConstantsWrapper | Wraps nkMaths::MathConstants and offers its values to use in scripting
C MatrixWrapper | Wraps a nkMaths::Matrix and offers functions for use in scripting
C QuaternionWrapper | Wraps a nkMaths::Quaternion and offers functions for use in scripting
C VectorWrapper | Wraps a nkMaths::Vector and offers functions for use in scripting
►N nkMemoryWrap | Encompasses the wrapping of nkMemory for scripting
C BufferCastWrapper | Wraps a nkMemory::BufferCast<T> and offers functions for use in scripting
C BufferViewWrapper | Wraps a nkMemory::BufferView<T> and offers functions for use in scripting
C BufferWrapper | Wraps a nkMemory::Buffer and offers functions for use in scripting
C Constants | Constants encompassing user type identifiers for the wrapping of nkMemory
C EnvironmentInitializer | Allows to initialize an environment to set up all the offered wrapping for nkMemory inside it
►N nkResourcesWrap | Encompasses the wrapping of nkResources for scripting
C Constants | Constants encompassing user type identifiers for the wrapping of nkResources
C EnvironmentInitializer | Allows to initialize an environment to set up all the offered wrapping for nkResources inside it
C ResourceManagerWrapper | Wraps a nkResources::ResourceManager and offer functions for use in scripting
►N nkScriptsWrap | Encompasses the wrapping of nkScripts for scripting
C CompilationFailureTypeWrapper | Wraps the nkScripts::COMPILATION_FAILURE_TYPE enum and offers capabilities to use it in scripts
C CompilationResultWrapper | Wraps a nkScripts::CompilationResult and offers capabilities to use it in scripts
C Constants | Constants encompassing user type identifiers for the wrapping of nkScripts
C EnvironmentInitializer | Allows to initialize an environment to set up all the offered wrapping for nkScripts inside it
C EnvironmentWrapper | Wraps a nkScripts::Environment and offer functions for use in scripting
C InterpreterWrapper | Wraps the nkScripts::INTERPRETER enum and offers capabilities to use it in scripts
C ScriptWrapper | Wraps a nkScripts::Script and offers functions for use in scripting
►N nkTasksWrap | Encompasses the wrapping of nkTasks for scripting
C Constants | Constants encompassing user type identifiers for the wrapping of nkTasks
C EnvironmentInitializer | Allows to initialize an environment to set up all the offered wrapping for nkTasks inside it
C SchedulerTaskWrapper | Wraps a nkTasks::Task and offers functions for use in scripting
C SchedulerWrapper | Wraps a nkTasks::Scheduler and offers functions for use in scripting
C TaskResultWrapper | Wraps the enum values of the nkTasks::TASK_RESULT
C ThreadSubmittedWorkWrapper | Wraps a nkTasks::ThreadSubmittedWork and offers functions for use in scripting
C ThreadWrapper | Wraps a nkAstraeus::lua::nkTasksWrap::LuaThread and offers functions for use in scripting
►N stdWrap | Encompasses the wrapping of std for scripting
C ArrayWrapperTemplate | Basic template class for wrapping a std::array into a scripting environment
C Constants | Constants encompassing user type identifiers for the wrapping of available std types
C EnvironmentInitializer | Allows to initialize an environment to set up all the offered wrapping for available std types inside it
C AtmosphereEffect | An atmosphere effect
C BlurComplexEffect | A blurring effect
C ComplexEffect | Base class for all complex effects in the component
C ComplexEffectManager | Manages the complex effects available in the component
C ComplexEffectTypeUtils | Offers utility functions to help with the enumeration support
C DofComplexEffect | A Depth of Field effect
C Effect | Base class for all effects in the component
C EffectManager | Manages the effects available in the component
C EffectTypeUtils | Offers utility functions to help with the enumeration support
C EnvironmentRenderer | Utility class helping with environment rendering such as cube maps or spherical maps
C FilmGrainEffect | A film grain effect
C FilmGrainEffectUtils | Utilities that can help when using an FilmGrainEffect
C FxaaEffect | A Fast Approximate Anti-Aliasing effect
C GeometryLib | Shader program helping sources for general geometry concepts
C GraphicsEngine | Drives the graphics engine part
C ImageEnvironmentEffect | Effect using a texture as an input to use it as an environment for the view
C LogManager | Responsible for logging all messages from the component. By registering a nkLog::Logger inside, it is possible to listen to all messages logged
C Material | Base class for all materials in the component
C MaterialManager | Manages the materials available in the component
C MaterialTypeUtils | Offers tools to work with the MATERIAL_TYPE enumeration
C MathsLib | Shader program helping sources for general maths concepts
C OneChannelPackUtils | Offers tools to work with the ONE_CHANNEL_PACK enumeration
C PbsEnvironmentMapFilter | Provides tools to filter environment maps and improve IBL within the PbsMaterial
C PbsMaterial | A Physically Based Shading material
C PostProcessingLib | Shader program helping sources to handle post processing passes
C ProjectLoader | Allows to load and save projects, that is, resource sets
C ProjectLoadQuery | Describes a project load query
C ProjectLoadResult | Holds information about a project load attempt
C ProjectSaveQuery | Describes a project save query
C ScriptsEngine | Drives the scripting sub engine
C ShadowMapParameters | Exposes parameters for the shadow map setup in materials and effects supporting it
C ShadowMapPcfUtils | Offers utilities around using the SHADOW_MAP_PCF enumeration
C ShadowMappingLib | Shader program helping sources for shadow mapping
C SsaoEffect | A Screen Space Ambient Occlusion effect
C SsaoEffectUtils | Utilities that can help when using an SsaoEffect
C System | The main entry point for nkAstraeus engine
C TextureCopyEffect | A texture copy effect
C ThreeChannelPackUtils | Offers utilities to use with the THREE_CHANNEL_PACK enumeration class
C ToneMappingEffect | A tone mapping effect meant to map linear values to display device colors
C ToneMappingHablesCurveDescriptor | Provides all parameters to tune the Hables curve to tone map an image
►N nkDebug | Encompasses all API of component NilkinsDebug
C ConsoleOutputFormatter | Implementation of a console friendly output formatting
C CpuDetector | Utility class allowing to get information on the CPU
C CpuInformation | Holds general information about a CPU
C DefaultTestObserver | Default implementation of a test run observer
C FunctionSet | A function set holding testing functions
C LogManager | Responsible for logging all messages from the component. By registering a nkLog::Logger inside, it is possible to listen to all messages logged
C NunitOutputFormatter | Implementation formatting test results in nUnit 3
C OutputFormatter | Base class for test's output formatting
C OutputTarget | Allows to customize the output target of test results
C RegisteredTestClass | Holds informations about a registered test class
C SimdInformation | Holds instruction set information
C SystemDetector | Utility class allowing to get information on the system
C TestClass | The test enabling class, allowing registration within the UnitTester
C TestClassObserverInformation | Information provided during a TestClass run
C TestFunction | Encapsulates a function registered for testing
C TestFunctionObserverInformation | Information provided during a function run
C TestObserver | Base for observer classes allowing to get notifications from a test run
C TestRunException | An exception raised when a test fails during an execution
C TestRunParameters | Parameters allowing to drive a test run sequence
C TestRunResult | Holds informations about a test execution result
C TestStackLevel | Holds information about a stack level
C TestUtils | Utilities to write tests
C UnitTester | Core of the component's testing capabilities
►N nkExport | Encompasses all API of component NilkinsExport
C Base64Encoder | Allows to encode and decode data into / from base64 encoding
C Exportable | An interface to define objects that can be exported using this component
C ExporterLoadResult | Holds the information about a try to import data sources
C ExportError | Holds information about a failure when trying to import an object using an Exporter
C JsonExporter | Exporter to use Json formatted data
C Node | A node in the tree structure representing the data to export / import
C TreeReader | Utility class providing an easier way to parse trees
C TreeReaderCompositeEntry | A templated version of a composite entry, aimed at filling containers
C TreeReaderEntry | An internal entry stored within the TreeReader
C TreeReaderTemplateEntry | Templated utility version of an entry within the tree reader
►N nkGraphics | Encompasses all API of component NilkinsGraphics
C AttributeGenerationInfo | Holds information for an attribute generation request
C AttributeGenerationOutput | Describes the output of an attribute generation operation
C AttributeGranularityUtils | Offers utility to work with the associated enumeration
C BlendState | Holds all information about the blend operations to use when rendering
C BlendStateManager | Manages the blend states recorded
C BoundingBox | A bounding box. Often used to encompass object's bounds in the world
C Buffer | A buffer that will reside on the GPU
C BufferManager | Manages the buffers recorded
C BufferSubResourceDescriptor | Describes how a buffer should be mapped
C Camera | Offers all controls to model a camera
C CameraManager | Manages the cameras recorded
C ClearTargetsPass | A clear target pass, during which some targets are cleared
C ComparisonFunctionUtils | Offers utility to work with the associated enumeration
C CompositeDecodeOptions | Aggregates all decoding options available for composite decoding
C CompositeEncoder | Allows to work with all formats supported, automatically
C Compositor | A compositor, describing how to compose the rendering pipeline
C CompositorManager | Manages the compositors recorded
C CompositorNode | A node in the rendering graph described by a Compositor
C ComputePass | A compute pass, during which a compute dispatch is launched
C Configuration | Configuration for the system's initialization
C ConstantBuffer | Describes a constant buffer
C ContentLoader | Utility class that allows to load content through their declaration files
C ContentLoadResult | Holds information about an attempt of parsing content declaration sources
C DecodedBufferData | Holds data about a decoded buffer
C DecodedData | Holds the result of an Encoder's decoding operation
C DecodedEntityData | Holds data about a decoded entity
C DecodedMaterialData | Holds data about a decoded material
C DecodedMeshData | Holds data about a decoded mesh
C DecodedNodeData | Holds data about a decoded node
C DecodedSkeletonData | Holds data about a decoded skeleton
C DecodedTextureData | Holds data about a decoded texture
C DefaultRenderStrategy | The default render strategy used within the component
C DepthStencilState | Holds information about a depth and stencil state used for rendering
C DepthStencilStateManager | Manages the depth stencil states recorded
C Entity | An entity in a render queue. It drives the shader and possible graph position for a set of renderables (SubEntity)
C EntityRenderInfo | Compiles the render information for an Entity to use within a RenderQueue
C EntityRenderInfoSlot | A slot within the render information
C EntityRenderLodSlot | A LOD slot to potentially draw, within a group slot
C FilterUtils | Offers utility to work with the associated enumeration
C Frustum | Defines a frustum
C GlobalTimer | A timer, giving timing capabilities
C GltfDecodeOptions | Decoding options for GlTF models
C GltfEncoder | Allows to work with the GLTF 2 format
C GltfEncoderUtils | Used internally
C IndexFormatUtils | Provides utility functions around the INDEX_FORMAT enum
C InfiniteBitMask | A utility class providing "infinite" masks, formed by bits, or booleans
C InfiniteMask | A more generic version of the InfiniteBitMask
C InstancingPass | A pass doing an instanced draw, during which one mesh is drawn X times, in one go
C LogManager | Responsible for logging all messages from the component
C MacroEntry | Holds information about a macro entry
C Manager | Base class for resource managers
C MapRequestDescriptor | A description of a request to map a resource
C MapResult | Contains all information of the result of a map operation on a resource
C Mesh | Holds information about a mesh. Used as a basis to render 3d models
C MeshFillOptions | Describes how a filling operation should behave
C MeshInputLayout | Describes the layout of data inside a mesh
C MeshInputLayoutAttribute | Describes an attribute in a mesh layout
C MeshManager | Manages the meshes recorded
C MeshUtils | Offers capabilities to ease the manipulation of meshes in some contexts
C MonoMaterialPass | A pass rendering the scene, using only one shader to render all the meshes enqueued
C Node | Represents a node in a scene graph
C NodeChangeListener | A base class for a listener for node changes
C NodeManager | Manages the nodes recorded
C ObjDecodeOptions | Describes all options available when decoding the obj format
C ObjEncoder | Allows to work with the Obj format
C PackedMeshData | Holds mesh low-level data once packed by the MeshUtils
C Pass | The base for a pass within a TargetOperations.
C PostProcessPass | A post processing pass, during which a shader is used to render a quad fitting on the screen
C PrimitiveTopologyUtils | Offers utility to work with the associated enumeration
C Program | Holds all informations related to GPU programs, and manages their compilation
C ProgramCompilationResult | Holds information about a complation result, from a program
C ProgramManager | Manages the programs recorded
C ProgramSourcesHolder | Holds the sources of a program
C RasterState | Holds information about a raster state
C RasterStateManager | Manages the raster states available in the component
C RaytracingPass | A raytracing pass. Dispatches rays, using hardware acceleration
C RenderCommand | Describes a render command and provides the necessary information for it to happen
C RenderCommandQueue | A queue of rendering commands
C RenderContext | A rendering context, attached to a window or an offscreen texture
C RenderContextDescriptor | A descriptor, used when creating a context along with its window
C RenderContextManager | Manages the render contexts recorded
C Renderer | A renderer, implementing the logic of using a graphics API
C RendererAbstractData | Encapsulates internals a Renderer can expose as a [key -> value] dictionary
C RendererSupportInfo | Informations about the supported features
C RenderQueue | A render queue, where all items that have to be rendered are queued
C RenderQueueManager | Manages the render queues recorded
C RenderScenePass | A pass rendering render queues
C RenderStrategy | A render strategy, used by a render queue to prepare the render commands
C Resource | Base class for a resource in the component
C ResourceDeclAugmentCallback | A callback called whenever a resource is being processed, during a save or load of resource set
C ResourceGpuCopyDescriptor | Holds information about a resource copy happening on the GPU only
C ResourceManager | Generic resource manager, enabling more intelligent processing of resources, compared to the ContentLoader
C ResourceSetLoadQuery | Holds information about a resource set (project) load query
C ResourceSetLoadResult | Holds the result of a loading operation for a resource set
C ResourceSetSaveQuery | Holds information about a resource set (project) saving query
C Sampler | Holds all the information needed of a sampler used during rendering
C SamplerManager | Manages the samplers recorded
C ScreenshotTaker | Utility class helping to isolate data from a render context
C Shader | A shader class, feeding data to a Program
C ShaderBoundResourceDesc | Holds information about a resource linked in a shader for feeding
C ShaderInstanceCustomDummySlot | A dummy custom instance slot
C ShaderInstanceCustomSlot | A custom slot, implementable by external code
C ShaderInstanceMemorySlot | A memory slot for per instance data in a Shader
C ShaderManager | Manages the shaders recorded
C ShaderMemorySlot | A memory slot in a memory resource
C ShaderPassCustomDummySlot | A dummy custom pass slot
C ShaderPassCustomSlot | A custom slot, implementable by external code
C ShaderPassMemorySlot | A memory slot that fits into a ConstantBuffer. The slot fills entries within the buffer
C ShaderResource | Base class for shader resources. Those are resources that can be fed to a Shader
C StreamOutputDescriptor | Holds information about a stream output slot
C StructToString | Converts enums to string, and vice versa
C System | Main interface with the component system
C TargetDescriptor | Describes how a target should be addressed during rendering
C TargetOperations | Describes a target operation set
C Texture | A texture used for rendering, hosted on GPU
C TextureAddressModeUtils | Offers utility to work with the associated enumeration
C TextureExternalData | External texture data, allowing to inject low-level constructs within the renderers
C TextureManager | Manages the textures available in the component
C TextureSaver | Utility class to save texture contents in files
C TextureSubResourceDescriptor | Describes how a texture should be mapped
C TextureUtils | Utility class to retrieve or compute interesting data about textures
C UnmapRequestDescriptor | Description of an unmap request
C VertexComposition | Describes how VertexData should be interpreted when generating low-level mesh data
C VertexData | A high-level mesh data representation
C Viewport | Holds all the information needed about a viewport
C ViewportManager | Manages the viewports available in the component
►N nkImages | Encompasses all API of component NilkinsImages
C AlignmentDescriptor | Holds information about alignment constraints
C AlignmentUtils | Offers tools to realign an image's memory
C BmpEncoder | Offers capabilities to encode and decode BMP format
C CompositeEncoder | Utility encoder using all other encoders within nkImages to parse arbitrary data
C ConversionUtils | Utility class offering helpers for conversions
C DdsEncoder | Offers capabilities to encode and decode DDS format
C HdrEncoder | Offers capabilities to encode and decode HDR format
C Image | Holds all information required for an image, with ownership over the data
C ImageBase | Base for all image data classes
C ImageDescriptor | Describes an image within an array. Used internally
C ImageView | Holds all information required for an image, with no ownership over the data
C JpgCompressionSettings | Describes available settings for Jpeg encoding queries
C JpgEncoder | Offers capabilities to encode and decode JPEG format
C LogManager | Responsible for logging all messages from the component
C MipDescriptor | Describes a mip within an image. Used internally
C PixelFormatUtils | Utility class to translate enum values into linked useful data
C PngEncoder | Offers capabilities to decode the PNG format
►N nkInputs | Encompasses all API of component NilkinsInputs
C GamepadDevice | A device abstracting a gamepad controller
C GamepadDeviceManager | Manages gamepad devices available in a System
C GamepadJoystickStatus | Holds a gamepad's joystick's status, for now its current position
C InputSystem | Interface with the back end input system
C KeyboardDevice | A keyboard device
C KeyboardDeviceManager | Manages keyboard devices available in a System
C LogManager | Responsible for logging all messages from the component
C MouseDevice | A mouse device
C MouseDeviceManager | Manages the mouse devices available in the component
C System | Main interface with the component
►N nkLog | Encompasses all API of component NilkinsLog
C ConsoleLogger | A default implementation for a Logger that will log messages into the console
C FileLogger | Default implementation of a logger outputing the logged information to a file
C Logger | An interface to make all logging capabilities central
C String | Allows to exchange strings with external code
C StringView | Allows to exchange strings with external code
►N nkMaths | Encompasses all API of component NilkinsMaths
C FloatEncoder | Provides functionalities to encode floats into different formats
C Hasher | Provides hashing capabilities
C IntVector | A 4-component vector class, with integers
C MathConstants | Availables constants
C Matrix | Represents a 4x4 float matrix
C Point | Represents a 2D Point
C Quaternion | A quaternion, symbolizing rotations as a 4D vector
C Rectangle | Represents a 2D rectangle
C Vector | A 4-component vector class, with floats
►N nkMemory | Encompasses all API of component NilkinsMemory
C Allocator | Interface representing an allocator, supposed to allocate an object when requested
C BitStream | Offers capabilities to read data bit per bit
C Buffer | A buffer holding binary data
C BufferCast | Holds a Buffer and make it easy to cast the binary data
C BufferDataDescriptor | Describes the data held by a buffer
C BufferView | A view over data
C Deallocator | Interface used for deallocating memory
C DefaultAllocator | A utility default allocator allocating an object through a simple call to new
C DefaultDeallocator | A utility default deallocator using a simple call to delete
C DefaultMemorySpace | A basic memory space with default implementation
C DefaultMemorySpaceAllocator | A default memory space allocator, offering the most basic memory allocation method
C DeflateEncoder | An encoder supporting Inflate/Deflate compression
C DeflateOutputStorage | Used internally to keep track of the output buffer status
C FreeListAllocation | Holds information about an allocation returned by the pager
C FreeListPager | A pager implementing the free list pattern
C HuffmanLut | Allows to create a Look-Up-Table (LUT) of a Huffman tree
C HuffmanSymbol | Holds a symbol's information within the Huffman LUT
C HuffmanTreeDescriptor | Descriptor for a Huffman LUT creation
C LinearPager | A pager using a linear allocation algorithm
C LogManager | Responsible for logging all messages from the component
C MemorySpace | Represents a memory space held by a page in a pager
C MemorySpaceAllocator | Defines the interface for a memory space allocator, to be used within the pagers
C PtrPool | A pool of objects, allocated in the heap and tracked by their pointers
C String | Class holding information about a string, with ownership over the data
C StringView | Class holding information about a string, with no ownership over the data
C UniquePtr | Smart pointer owning the object instance it encapsulates
►N nkResources | Encompasses all API of component NilkinsResources
C LogManager | The log manager class attached to this component
C ResourceManager | Manager helping with path finding and resource loading
►N nkScripts | Encompasses all API of component NilkinsScripts
C ArrayAccessorDescriptor | Holds information about the way to access a user type as an array
C CompilationResult | Holds information about script loading attempt
C ContentLoader | Allows to export and import content through their declaration files
C ContentLoadResult | Holds information about a content load attempt
C Environment | Defines an environment in which scripts can execute
C EnvironmentManager | Manages the environments available
C ExecutionResult | Holds information about the execution result of a script in an environment
C Function | Holds information, and controls, over a function in a scripting environment
C FunctionParameter | A function parameter, used within the stack of arguments
C LogManager | Responsible for logging all messages from the component
C Namespace | Holds information and allow control over a namespace in a scripting environment
C ProjectLoader | Offers project loading / saving capabilities
C ProjectLoadQuery | Holds information about a project load query
C ProjectLoadResult | Holds information about a project load attempt
C ProjectSaveQuery | Holds information for a project saving query
C ResourceDeclAugmentCallback | Represents a callback enabling to "augment" a loading or saving of a project
C Script | Holds all information for a script
C ScriptManager | Manages the scripts available in the component
C ScriptObjectInterpreterReference | Base interface for interpreter specific reference over script object
C ScriptObjectInterpreterView | Base interface for an interpreter specific script object view
C ScriptObjectReference | A reference over an object in the scripting environment
C ScriptObjectReferenceStruct | Holds information about a reference
C ScriptObjectView | A view over an object in the scripting environment
C StringUtils | Utility for string manipulations
C UserType | Represents a user type and all the information and control related
C UserTypeFieldDescriptor | Holds all the information required to define a field
C UserTypeHolder | Holds information about a user type parameter
►N nkTasks | Encompasses all API of component NilkinsTasks
C LambdaSchedulerTask | Utility scheduler task using lambda functions to work
C LambdaTask | Utility task using lambda functions to submit work
C LogManager | Responsible for logging all messages from the component
C Scheduler | Manages a ThreadPool and eases the synchronization with the managing thread
C SchedulerTask | A task compatible with the Scheduler, adding a synchronization point
C Task | A task, job that can be submitted to a nkTasks::Thread
C Thread | Symbolizes a thread. Base block to submit off-thread nkTasks::Task in this component
C ThreadPool | A pool with pre-created threads, allowing to queue work asynchronously
►N nkWinUi | Encompasses all API of component NilkinsWinUi
C AlignmentUtils | Holds static utility functions to interact with the ALIGNMENT enum class values
C Button | A graphical button
C ChangeEventData | Data holder for a change event
C CharEventData | Data holder for a char event
C CheckBox | A graphical check box
C ClickEventData | Data holder for a click event
C Clipboard | Abstracts the system clipboard
C Color | Represents a color, with 4 channels
►C ComboBox | A graphical combo box
C Entry | Represents an entry within the combo box
C Component | Base class for any graphical component
C ComponentManager | Manages the components within nkWinUi
C ComponentUtils | Offers many utilities to deal with the components, specialized for its windowing system
C ContentLoader | Allows to export and import content through their declaration files
►C ContextMenu | A graphical context menu
C Item | An item within the context menu component
C Cursor | WIP
C CursorManager | Manages the recorded cursors living in the component
C CursorUtils | A utility class to interact with the cursor
C EditBox | A graphical single line edit box
►C FileExplorer | A graphical file explorer
C FileFilter | Used to filter files in the interface
C Font | Offers an interface to work with fonts
C FontManager | Manages the recorded fonts [WIP]
C FontUtils | Offers utility features to work with fonts
C GridLayout | Implements a layout organizing children components in a grid
C GroupBox | A graphical group box
C HandledEventData | Data holder for a handled event
C Image | Abstracts an image to be used within the component
C ImageDisplay | Allows to display an image in the Ui
C ImageManager | Manages the images in the component
C InputDescriptor | Describes an input event
C InputSystem | Input system, centralizing default behaviour for the input
C KeyEventData | Data holder for a key event
C Layout | Represents a layout to organize children of a component
►C ListBox | A graphical list box
C Item |
C LogManager | Responsible for logging all messages from the component
C LogWin | A graphical log window, where lines can be added like a console log
C MouseMoveEventData | Data holder for a mouse move event
C MultiLineEdit | A graphical multi line edit box
C NotificationPositionDescriptor | Describes the position constraints a notification or popup should satisfy
C Notificator | Gather notification and popup related functions
C PopupCustomDescriptor | Describes how a custom popup should behave
C PopupYesNoDescriptor | Describes the behaviour a yes / no popup should have
C ProgressBar | WIP
C RelativeLayout | Implements a layout positioning its children components relative to each other
C RelativePositionUtils | Holds static utility functions to interact with the RELATIVE_POSITION enum class values
C ScrollBar | A graphical scroll bar
C Slider | A graphical slider
C Static | A graphical static text zone
C StructToString | Offers utilities to convert from structures or enums to strings, and vice versa
C System | The main system of the component
►C TabWindow | A graphical tab window
C Tab | Holds information about a tab in the window
C Theme | A theme used to style the windows in the component
C ThemeColors | Information about all the colors a theme will need
C ThemeManager | Manages the themes within the component
►C ToolBar | A ToolBar in which items can be added to offer different capabilities
C Item | Represents an item within a ToolBar
►C TreeView | A graphical tree view window
C Item | Holds information of a tree view item
C WheelEventData | Data holder for a wheel event
C Window | A graphical window, made for general purpose
C WindowingSystem | Class abstracting the windowing system used